Use regular imports instead of require where possible by jakebailey · Pull Request #59017 · microsoft/TypeScript

jakebailey · 2024-06-25T17:55:00Z

This is pulled out of #58419, since I think this is generally better and we can do it now.

src/tsserver/nodeServer.ts

jakebailey · 2024-06-25T20:05:29Z

typescript-bot · 2024-06-25T20:05:32Z

Starting jobs; this comment will be updated as builds start and complete.

Command	Status	Results
`perf test this`	✅ Started	👀 Results

typescript-bot · 2024-06-25T20:46:53Z

@jakebailey
The results of the perf run you requested are in!

Here they are:

tsc

Comparison Report - baseline..pr

_Metric	_baseline	_pr	_Delta	_Best	_Worst	_p-value
_{Compiler-Unions - node (v18.15.0, x64)}
_Errors	₃₀	₃₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_62,153	_62,153	_~	_~	_~	_{p=1.000 n=6}
_Types	_50,242	_50,242	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{192,704k (± 0.60%)}	_{193,959k (± 0.99%)}	_~	_192,161k	_195,778k	_{p=0.128 n=6}
_{Parse Time}	_{1.58s (± 0.26%)}	_{1.58s (± 0.48%)}	_~	_1.57s	_1.59s	_{p=1.000 n=6}
_{Bind Time}	_{0.86s (± 1.14%)}	_{0.86s (± 0.73%)}	_~	_0.85s	_0.87s	_{p=0.733 n=6}
_{Check Time}	_{11.21s (± 0.23%)}	_{11.19s (± 0.43%)}	_~	_11.12s	_11.25s	_{p=0.422 n=6}
_{Emit Time}	_{3.27s (± 0.32%)}	_{3.27s (± 0.46%)}	_~	_3.26s	_3.30s	_{p=0.282 n=6}
_{Total Time}	_{16.91s (± 0.13%)}	_{16.90s (± 0.28%)}	_~	_16.83s	_16.96s	_{p=0.810 n=6}
_{angular-1 - node (v18.15.0, x64)}
_Errors	₅	₅	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_944,114	_944,114	_~	_~	_~	_{p=1.000 n=6}
_Types	_407,050	_407,050	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{1,218,311k (± 0.00%)}	_{1,218,293k (± 0.00%)}	_~	_1,218,209k	_1,218,378k	_{p=0.575 n=6}
_{Parse Time}	_{7.96s (± 0.93%)}	_{7.94s (± 0.31%)}	_~	_7.91s	_7.98s	_{p=0.573 n=6}
_{Bind Time}	_{2.23s (± 0.23%)}	_{2.24s (± 0.24%)}	_{+0.01s (+ 0.37%)}	_2.23s	_2.24s	_{p=0.038 n=6}
_{Check Time}	_{35.74s (± 0.29%)}	_{35.72s (± 0.34%)}	_~	_35.50s	_35.86s	_{p=0.809 n=6}
_{Emit Time}	_{16.12s (± 0.42%)}	_{16.16s (± 0.32%)}	_~	_16.12s	_16.26s	_{p=0.687 n=6}
_{Total Time}	_{62.06s (± 0.29%)}	_{62.05s (± 0.24%)}	_~	_61.80s	_62.22s	_{p=1.000 n=6}
_{mui-docs - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_2,135,096	_2,135,096	_~	_~	_~	_{p=1.000 n=6}
_Types	_927,168	_927,168	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{2,117,354k (± 0.01%)}	_{2,117,357k (± 0.01%)}	_~	_2,117,234k	_2,117,506k	_{p=0.810 n=6}
_{Parse Time}	_{7.91s (± 0.27%)}	_{7.92s (± 0.37%)}	_~	_7.88s	_7.96s	_{p=0.468 n=6}
_{Bind Time}	_{2.76s (± 0.61%)}	_{2.77s (± 0.62%)}	_~	_2.74s	_2.79s	_{p=0.465 n=6}
_{Check Time}	_{83.53s (± 0.32%)}	_{83.85s (± 0.19%)}	_~	_83.69s	_84.07s	_{p=0.093 n=6}
_{Emit Time}	_{0.16s (± 4.65%)}	_{0.16s (± 4.65%)}	_~	_0.15s	_0.17s	_{p=1.000 n=6}
_{Total Time}	_{94.36s (± 0.28%)}	_{94.70s (± 0.16%)}	_{+0.34s (+ 0.36%)}	_94.51s	_94.91s	_{p=0.031 n=6}
_{self-build-src - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_1,230,869	_1,231,459	_{+590 (+ 0.05%)}	_~	_~	_{p=0.001 n=6}
_Types	_261,077	_261,178	_{+101 (+ 0.04%)}	_~	_~	_{p=0.001 n=6}
_{Memory used}	_{2,356,017k (± 1.01%)}	_{2,347,553k (± 0.03%)}	_~	_2,346,575k	_2,348,323k	_{p=0.173 n=6}
_{Parse Time}	_{5.98s (± 0.53%)}	_{6.00s (± 1.29%)}	_~	_5.92s	_6.12s	_{p=0.936 n=6}
_{Bind Time}	_{2.26s (± 0.66%)}	_{2.27s (± 0.60%)}	_~	_2.26s	_2.29s	_{p=0.369 n=6}
_{Check Time}	_{39.77s (± 0.54%)}	_{40.27s (± 0.24%)}	_{+0.50s (+ 1.26%)}	_40.15s	_40.37s	_{p=0.005 n=6}
_{Emit Time}	_{3.21s (± 1.51%)}	_{3.24s (± 1.87%)}	_~	_3.16s	_3.30s	_{p=0.335 n=6}
_{Total Time}	_{51.22s (± 0.42%)}	_{51.80s (± 0.30%)}	_{+0.58s (+ 1.13%)}	_51.62s	_51.98s	_{p=0.005 n=6}
_{self-build-src-public-api - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_1,230,869	_1,231,459	_{+590 (+ 0.05%)}	_~	_~	_{p=0.001 n=6}
_Types	_261,077	_261,178	_{+101 (+ 0.04%)}	_~	_~	_{p=0.001 n=6}
_{Memory used}	_{2,421,915k (± 0.02%)}	_{2,423,132k (± 0.02%)}	_{+1,218k (+ 0.05%)}	_2,422,625k	_2,423,855k	_{p=0.013 n=6}
_{Parse Time}	_{5.16s (± 0.53%)}	_{5.22s (± 0.84%)}	_{+0.06s (+ 1.26%)}	_5.15s	_5.28s	_{p=0.030 n=6}
_{Bind Time}	_{1.68s (± 0.48%)}	_{1.70s (± 1.05%)}	_~	_1.67s	_1.72s	_{p=0.085 n=6}
_{Check Time}	_{34.16s (± 0.37%)}	_{34.51s (± 0.19%)}	_{+0.35s (+ 1.03%)}	_34.41s	_34.60s	_{p=0.005 n=6}
_{Emit Time}	_{2.68s (± 2.29%)}	_{2.76s (± 1.81%)}	_~	_2.67s	_2.81s	_{p=0.066 n=6}
_{Total Time}	_{43.72s (± 0.31%)}	_{44.21s (± 0.24%)}	_{+0.50s (+ 1.13%)}	_44.12s	_44.41s	_{p=0.005 n=6}
_{self-compiler - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_258,577	_258,577	_~	_~	_~	_{p=1.000 n=6}
_Types	_104,827	_104,827	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{428,182k (± 0.01%)}	_{428,194k (± 0.01%)}	_~	_428,158k	_428,273k	_{p=0.810 n=6}
_{Parse Time}	_{2.75s (± 0.67%)}	_{2.74s (± 0.72%)}	_~	_2.71s	_2.76s	_{p=0.935 n=6}
_{Bind Time}	_{1.11s (± 1.51%)}	_{1.11s (± 1.75%)}	_~	_1.08s	_1.13s	_{p=1.000 n=6}
_{Check Time}	_{15.08s (± 0.29%)}	_{15.07s (± 0.37%)}	_~	_14.97s	_15.14s	_{p=1.000 n=6}
_{Emit Time}	_{1.16s (± 1.33%)}	_{1.15s (± 0.95%)}	_~	_1.13s	_1.16s	_{p=0.359 n=6}
_{Total Time}	_{20.10s (± 0.20%)}	_{20.07s (± 0.34%)}	_~	_19.97s	_20.17s	_{p=0.574 n=6}
_{ts-pre-modules - node (v18.15.0, x64)}
_Errors	₃₅	₃₅	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_224,565	_224,565	_~	_~	_~	_{p=1.000 n=6}
_Types	_93,734	_93,734	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{369,470k (± 0.03%)}	_{369,426k (± 0.03%)}	_~	_369,341k	_369,604k	_{p=0.471 n=6}
_{Parse Time}	_{2.31s (± 0.51%)}	_{2.31s (± 0.33%)}	_~	_2.30s	_2.32s	_{p=0.933 n=6}
_{Bind Time}	_{1.34s (± 1.46%)}	_{1.33s (± 1.32%)}	_~	_1.31s	_1.36s	_{p=0.176 n=6}
_{Check Time}	_{13.13s (± 0.22%)}	_{13.15s (± 0.28%)}	_~	_13.11s	_13.20s	_{p=0.466 n=6}
_{Emit Time}	_0.00s	_0.00s	_~	_~	_~	_{p=1.000 n=6}
_{Total Time}	_{16.79s (± 0.25%)}	_{16.79s (± 0.27%)}	_~	_16.74s	_16.86s	_{p=0.873 n=6}
_{vscode - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_2,878,705	_2,878,705	_~	_~	_~	_{p=1.000 n=6}
_Types	_975,213	_975,213	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{3,041,995k (± 0.00%)}	_{3,041,998k (± 0.00%)}	_~	_3,041,926k	_3,042,059k	_{p=1.000 n=6}
_{Parse Time}	_{13.51s (± 0.41%)}	_{13.48s (± 0.30%)}	_~	_13.41s	_13.52s	_{p=0.684 n=6}
_{Bind Time}	_{4.15s (± 0.34%)}	_{4.19s (± 1.99%)}	_~	_4.15s	_4.36s	_{p=0.245 n=6}
_{Check Time}	_{72.82s (± 0.23%)}	_{72.98s (± 0.21%)}	_~	_72.79s	_73.20s	_{p=0.092 n=6}
_{Emit Time}	_{23.91s (± 1.00%)}	_{23.86s (± 0.17%)}	_~	_23.78s	_23.90s	_{p=0.575 n=6}
_{Total Time}	_{114.38s (± 0.24%)}	_{114.51s (± 0.19%)}	_~	_114.22s	_114.75s	_{p=0.471 n=6}
_{webpack - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_267,117	_267,117	_~	_~	_~	_{p=1.000 n=6}
_Types	_108,775	_108,775	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{411,568k (± 0.03%)}	_{411,537k (± 0.01%)}	_~	_411,464k	_411,602k	_{p=0.936 n=6}
_{Parse Time}	_{3.80s (± 0.56%)}	_{3.81s (± 0.61%)}	_~	_3.78s	_3.84s	_{p=0.464 n=6}
_{Bind Time}	_{1.69s (± 0.61%)}	_{1.68s (± 0.45%)}	_~	_1.67s	_1.69s	_{p=0.351 n=6}
_{Check Time}	_{16.70s (± 0.48%)}	_{16.67s (± 0.23%)}	_~	_16.62s	_16.72s	_{p=0.686 n=6}
_{Emit Time}	_0.00s	_0.00s	_~	_~	_~	_{p=1.000 n=6}
_{Total Time}	_{22.19s (± 0.35%)}	_{22.17s (± 0.17%)}	_~	_22.10s	_22.20s	_{p=1.000 n=6}
_{xstate-main - node (v18.15.0, x64)}
_Errors	₀	₀	_~	_~	_~	_{p=1.000 n=6}
_Symbols	_525,251	_525,251	_~	_~	_~	_{p=1.000 n=6}
_Types	_178,574	_178,574	_~	_~	_~	_{p=1.000 n=6}
_{Memory used}	_{462,894k (± 0.05%)}	_{462,994k (± 0.07%)}	_~	_462,386k	_463,267k	_{p=0.298 n=6}
_{Parse Time}	_{2.65s (± 0.37%)}	_{2.64s (± 0.57%)}	_~	_2.62s	_2.66s	_{p=0.360 n=6}
_{Bind Time}	_{0.98s (± 0.64%)}	_{0.98s (± 0.53%)}	_~	_0.97s	_0.98s	_{p=0.386 n=6}
_{Check Time}	_{15.16s (± 0.43%)}	_{15.16s (± 0.28%)}	_~	_15.08s	_15.20s	_{p=0.687 n=6}
_{Emit Time}	_0.00s	_0.00s	_~	_~	_~	_{p=1.000 n=6}
_{Total Time}	_{18.79s (± 0.33%)}	_{18.78s (± 0.26%)}	_~	_18.69s	_18.83s	_{p=0.630 n=6}

System info unknown

Hosts

node (v18.15.0, x64)

Scenarios

Compiler-Unions - node (v18.15.0, x64)
angular-1 - node (v18.15.0, x64)
mui-docs - node (v18.15.0, x64)
self-build-src - node (v18.15.0, x64)
self-build-src-public-api - node (v18.15.0, x64)
self-compiler - node (v18.15.0, x64)
ts-pre-modules - node (v18.15.0, x64)
vscode - node (v18.15.0, x64)
webpack - node (v18.15.0, x64)
xstate-main - node (v18.15.0, x64)

_Benchmark	_Name	_Iterations
_Current	_pr	₆
_Baseline	_baseline	₆

tsserver

Comparison Report - baseline..pr

_Metric	_baseline	_pr	_Delta	_Best	_Worst	_p-value
_{Compiler-UnionsTSServer - node (v18.15.0, x64)}
_{Req 1 - updateOpen}	_{2,779ms (± 0.60%)}	_{2,755ms (± 1.39%)}	_~	_2,705ms	_2,797ms	_{p=0.575 n=6}
_{Req 2 - geterr}	_{6,934ms (± 9.62%)}	_{6,280ms (± 8.74%)}	_~	_6,022ms	_7,399ms	_{p=0.128 n=6}
_{Req 3 - references}	_{370ms (±10.38%)}	_{358ms (±11.79%)}	_~	_318ms	_397ms	_{p=0.808 n=6}
_{Req 4 - navto}	_{341ms (± 0.16%)}	_340ms	_~	_~	_~	_{p=0.071 n=6}
_{Req 5 - completionInfo count}	_1,357	_1,357	_~	_~	_~	_{p=1.000 n=6}
_{Req 5 - completionInfo}	_{131ms (± 0.39%)}	_{132ms (± 1.17%)}	_~	_131ms	_135ms	_{p=0.523 n=6}
_{CompilerTSServer - node (v18.15.0, x64)}
_{Req 1 - updateOpen}	_{2,412ms (± 0.72%)}	_{2,431ms (± 0.40%)}	_~	_2,420ms	_2,445ms	_{p=0.054 n=6}
_{Req 2 - geterr}	_{3,797ms (± 0.15%)}	_{3,797ms (± 0.24%)}	_~	_3,780ms	_3,807ms	_{p=0.688 n=6}
_{Req 3 - references}	_{276ms (± 0.85%)}	_{278ms (± 0.20%)}	_~	_277ms	_278ms	_{p=0.228 n=6}
_{Req 4 - navto}	_{229ms (± 2.71%)}	_{226ms (± 0.43%)}	_~	_225ms	_227ms	_{p=0.865 n=6}
_{Req 5 - completionInfo count}	_1,519	_1,519	_~	_~	_~	_{p=1.000 n=6}
_{Req 5 - completionInfo}	_{74ms (± 8.05%)}	_{74ms (± 0.74%)}	_~	_73ms	_74ms	_{p=0.154 n=6}
_{xstate-main-1-tsserver - node (v18.15.0, x64)}
_{Req 1 - updateOpen}	_{7,702ms (± 0.47%)}	_{6,369ms (± 4.96%)}	_{🟩-1,333ms (-17.31%)}	_6,215ms	_7,013ms	_{p=0.005 n=6}
_{Req 2 - geterr}	_{1,683ms (± 1.00%)}	_{1,594ms (±11.50%)}	_~	_1,348ms	_1,734ms	_{p=0.689 n=6}
_{Req 3 - references}	_{111ms (± 5.00%)}	_{105ms (± 0.52%)}	_~	_104ms	_105ms	_{p=0.152 n=6}
_{Req 4 - navto}	_{611ms (± 2.34%)}	_{596ms (± 1.42%)}	_{-15ms (- 2.48%)}	_581ms	_603ms	_{p=0.029 n=6}
_{Req 5 - completionInfo count}	_3,413	_3,413	_~	_~	_~	_{p=1.000 n=6}
_{Req 5 - completionInfo}	_{1,274ms (± 2.17%)}	_{1,245ms (± 0.77%)}	_~	_1,235ms	_1,259ms	_{p=0.128 n=6}

System info unknown

Hosts

node (v18.15.0, x64)

Scenarios

CompilerTSServer - node (v18.15.0, x64)
Compiler-UnionsTSServer - node (v18.15.0, x64)
xstate-main-1-tsserver - node (v18.15.0, x64)

_Benchmark	_Name	_Iterations
_Current	_pr	₆
_Baseline	_baseline	₆

startup

Comparison Report - baseline..pr

_Metric	_baseline	_pr	_Delta	_Best	_Worst	_p-value
_{tsc-startup - node (v18.15.0, x64)}
_{Execution time}	_{187.95ms (± 0.17%)}	_{187.93ms (± 0.19%)}	_~	_186.20ms	_191.43ms	_{p=0.214 n=600}
_{tsserver-startup - node (v18.15.0, x64)}
_{Execution time}	_{284.80ms (± 0.27%)}	_{284.84ms (± 0.26%)}	_~	_278.07ms	_287.68ms	_{p=0.673 n=600}
_{tsserverlibrary-startup - node (v18.15.0, x64)}
_{Execution time}	_{279.23ms (± 0.29%)}	_{279.09ms (± 0.29%)}	_{-0.14ms (- 0.05%)}	_272.66ms	_286.93ms	_{p=0.000 n=600}
_{typescript-startup - node (v18.15.0, x64)}
_{Execution time}	_{338.88ms (± 0.30%)}	_{338.67ms (± 0.29%)}	_{-0.21ms (- 0.06%)}	_330.51ms	_348.20ms	_{p=0.000 n=600}

System info unknown

Hosts

node (v18.15.0, x64)

Scenarios

tsc-startup - node (v18.15.0, x64)
tsserver-startup - node (v18.15.0, x64)
tsserverlibrary-startup - node (v18.15.0, x64)
typescript-startup - node (v18.15.0, x64)

_Benchmark	_Name	_Iterations
_Current	_pr	₆
_Baseline	_baseline	₆

Developer Information:

Download Benchmarks

DanielRosenwasser · 2024-07-03T21:23:15Z

src/tsserver/nodeServer.ts

+import childProcess from "child_process";
+import fs from "fs";
+import net from "net";
+import os from "os";
+import readline from "readline";


Is there any risk now that these are unconditional imports?

Nope, this is the tsserver project which only runs in node.

mmkal · 2024-10-17T03:17:03Z

src/tsserver/nodeServer.ts

    let cancellationToken: ts.server.ServerCancellationToken;
    try {
-        const factory = require("./cancellationToken");
+        const factory = require("./cancellationToken.js");


Hi, I came across this line running dependency-cruiser on the typescript codebase. After building, it's the only require/import that can't be resolved. I notice that this file, nodeServer, does not have a cancellationToken sibling file - is it possible that this is always throwing (seems like it could be, since the catch block silently catches the error and uses ts.server.nullCancellationToken)

This file should exist as a sibling. https://unpkg.com/browse/typescript@5.6.3/lib/cancellationToken.js

Are you running this tool on the built code, or the source?

(realistically, it's not clear to me why this is a separate file at all anyway)

Oh I see. I'm running it on the source, so I guess it's missing some part of the build process that compiles src/tsserver/nodeServer.ts into lib/tsserver.js, and src/cancellationToken/cancellationToken.ts into lib/cancellationToken.js, is that right? (Something in Hereby?)

Would it not work as require("../cancellationToken/cancellationToken.js") (which I think is what would be correct for the source file structure)

No, that would not work. Our input source structure has nothing to do with our output source structure; it's bundled and placed in a different directory.

Got it - thanks very much!

#60250 you've inspired me

jakebailey added 2 commits June 25, 2024 10:45

Use regular imports instead of require where possible

29c2715

Not conditional, it's imported

433073c

typescript-bot assigned jakebailey Jun 25, 2024

typescript-bot added Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Jun 25, 2024

jakebailey commented Jun 25, 2024

View reviewed changes

src/tsserver/nodeServer.ts Outdated Show resolved Hide resolved

Update src/tsserver/nodeServer.ts

05737b4

jakebailey requested review from andrewbranch, sheetalkamat and weswigham June 25, 2024 17:59

sheetalkamat approved these changes Jun 25, 2024

View reviewed changes

jakebailey merged commit ef339af into microsoft:main Jun 25, 2024

jakebailey deleted the use-imports branch June 25, 2024 21:00

DanielRosenwasser reviewed Jul 3, 2024

View reviewed changes

RyanCavanaugh mentioned this pull request Oct 7, 2024

fix automatic type acquisition #60157

Merged

mmkal reviewed Oct 17, 2024

View reviewed changes

sandersn removed this from PR Backlog Apr 22, 2025

microsoft locked as resolved and limited conversation to collaborators Oct 16, 2025

Conversation

jakebailey commented Jun 25, 2024

Uh oh!

Uh oh!

jakebailey commented Jun 25, 2024

Uh oh!

typescript-bot commented Jun 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Jun 25, 2024

tsc

tsserver

startup

Uh oh!

DanielRosenwasser Jul 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

typescript-bot commented Jun 25, 2024 •

edited

Loading

DanielRosenwasser Jul 3, 2024 •

edited

Loading